Skip to content

MkCommandOutput

Show source on GitHub

Node to display the terminal output of a command.

Example: Regular

Jinja

{{ ["hatch", "--help"] | MkCommandOutput }}

Python

MkCommandOutput(['hatch', '--help'])

hatch --help /bin/sh: 1: hatch: not found 

<div data-terminal>
  <span data-ty="input">hatch --help</span>
  <span data-ty>/bin/sh: 1: hatch: not found</span>
</div>

<div data-terminal>
  <span data-ty="input">hatch --help</span>
  <span data-ty>/bin/sh: 1: hatch: not found</span>
</div>

Bases: MkTemplate

__init__ 

__init__(call: Sequence[str], **kwargs: Any)

Parameters:

Name Type Description Default
call Sequence[str]

System call to make

 required
kwargs Any

Keyword arguments passed to parent

 {}
Name Children Inherits
MkTemplate
mknodes.templatenodes.mktemplate
Node representing a jinja template.		 
graph TD
  94875593935504["mkcommandoutput.MkCommandOutput"]
  94875592700464["mktemplate.MkTemplate"]
  94875590900096["mkcontainer.MkContainer"]
  94875594508576["mknode.MkNode"]
  94875592833088["node.Node"]
  140216716431552["builtins.object"]
  94875592700464 --> 94875593935504
  94875590900096 --> 94875592700464
  94875594508576 --> 94875590900096
  94875592833088 --> 94875594508576
  140216716431552 --> 94875592833088
/home/runner/work/mknodes/mknodes/mknodes/templatenodes/mkcommandoutput/metadata.toml
[metadata]
icon = "mdi:bash"
name = "MkCommandOutput"

[[resources.css]]
filename = "terminal.css"

[examples.regular]
condition = "{{ 'CI' | getenv }}"
title = "Regular"
jinja = """
{{ ["hatch", "--help"] | MkCommandOutput }}
"""

[output.html]
template = """
<div data-terminal>
  <span data-ty="input">{{ node.call | join(" ") }}</span>
  <span data-ty>{{ node.call | check_output(cwd=node.cwd) }}</span>
</div>
"""
mknodes.templatenodes.mkcommandoutput.MkCommandOutput
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class MkCommandOutput(mktemplate.MkTemplate):
    """Node to display the terminal output of a command."""

    ICON = "material/bash"
    STATUS = "new"
    CSS = [resources.CSSFile("terminal.css")]

    def __init__(self, call: Sequence[str], **kwargs: Any):
        """Constructor.

        Args:
            call: System call to make
            kwargs: Keyword arguments passed to parent
        """
        self.call = call
        super().__init__("output/html/template", **kwargs)

    @property
    def cwd(self):
        return self.ctx.metadata.repository_path